LimsSpecimens Web Service
MethodLimsSpecimensIndex
Description
This index method provides an array of CoreOne Lims Specimens that match any search criteria provided.
Request (LimsSpecimensIndex)

Below are the required parameters to successfully return an array of CoreOne Lims Specimens that fall within a specified time frame and are associated with a specified entity. If any parameter is omitted an error message will be displayed alerting the user.

Request Body Parameters

NameDescriptionData Type
token

This is a 40-character hexadecimal string.

This token should have been obtained at the commencement of a session using the Login (Method). It is required for all functional CoreOne web services.
xml:string
search

This is a space-delimited list of search terms which will be used to filter your search results. If multiple search terms are supplied the search is additive in nature. It is not case sensitive. If omitted, the search defaults to an empty string.

xml:string
page

Results from this method are paginated; this parameter specifies the page number you wish returned. If omitted, the default page number is 1.

xml:int
limit

Results from this method are paginated; this parameter specifies the number of items per page that are returned. If omitted, the default limit is 15. This is to prevent mass data extraction.

xml:int
start_dateThis is used as the start date of a time frame to return Lims Accessions that where created after this specified date. It is a required parameter and must be in format YYYY-MM-DD.xml:date
end_dateThis is used as the end date of a time frame to return Lims Accessions that where created before this specified date. It is a required parameter and must be in format YYYY-MM-DD.xml:date
entity_typeThis is the type of entity the Lims Specimen is associated with. It can be 0 - Premises, 1 - Herd, 2 - Animal.xml:int
entity_id

This is an internal CoreOne id used to uniquely identify the specified record.

These can be obtained through using the respective entity_type Index (Methods)

xml:int
Response (LimsSpecimensIndex_response)

This will return a list of CoreOne Lims Specimens along with each Lims Specimen's details.

To get the full view of the associated Lims Accession use the LimsAccessionsShow (Method).

Response Body Parameters

NameDescriptionData Type
valueThis is an array which shows all data elements for each CoreOne Lims Specimens returned.ws_lims_specimen
Remarks

See Also
All Operations Resource GroupLimsSpecimens Web Service

 

 


© 2014-2018 All Rights Reserved.

Send comments on this topic.